Help File for IslEdit
=====================


About IslEdit
-------------

IslEdit is a level editor for the Islands desktop game. It allows you to
overlay networks of interlinked 'nodes' on a background sprite in order
to create a map. You can also name the various continents and set bonus
values and other parameters. The Islands game is also available from
www.lym.iconbar.com.


Level format
------------

Islands levels are comprised of two files within a single directory: a
sprite file (prefixed 'S'), and a data file (prefixed 'D'). The
directory name is the name of the level. So, for a level called 'World',
the structure would be:

          World
            |
       ------------
       |          |
    SWorld      DWorld

Each of these level directories is stored in the 'Levels' directory
within the Islands application, and when Islands is run it is added to
the list of available levels in the Choices dialogue box.

The sprite file is used as the backdrop to the level. It has no special
properties, but it must clearly display to the user which territories
are accesible from which others. It should also indicate through
colouring which territories belong to which continent. Finally, it
should indicate the names of the continents. Have a look at the 'SWorld'
file in the Islands application for an example.

Islands levels are grids, with a minimum x dimension of 12, a maximum x
dimension of 32, a minimum y dimension of 12, and a maximum y dimension
of 24. As each grid is 20 pixels (or 40 OS units) square, every backdrop
sprite should be within the range 240-640px wide and 240-480px high, in
multiples of 20px.

The data file holds the information the game needs to determine which
territories may be attacked from which others, and which territories are
part of a continent. It is this file which IslEdit allows you to create
and edit.


Loading and saving a level file
-------------------------------

To load a file, run IslEdit by double-clicking on its icon. Then drag a
datafile from an existing level directory on to the iconbar icon.
IslEdit will load this file as well as the accompanying backdrop sprite
and display it in a window. Each territory in the game is represented by
a square 'node'. The links between nodes are represented by black lines.
The continent a node belongs to is determined by its colour.

Once edited, a datafile can be saved in the normal way by dragging the
file icon from a save window (from the main menu, choose, File>Save). If
the level directory is then copied into the Levels directory within
Islands, then the edited level will be available for use. Note that
IslEdit doesn't do anything with the sprite file: it's up to you to make
sure the correct version is in the right directory with the data file.


Editing nodes
-------------

The three buttons at the top of the IslEdit window allow you to select
an existing node, create new ones, or delete them. A maximum of twelve
nodes may be creatred per continent. If you delete a node, its links to
all other nodes are also deleted. 

Links are created by selecting a node and then clicking with the Adjust
mouse button on another node. The two nodes will then be joined by a
black line. Using the menu, you can also de-link a node from all others
if you've made a mistake.

Nodes are created in the colour of the continent to which they belong.
You can set up continents (called 'Islands' in IslEdit) by going to
Map>Islands in the main menu. You can add new Islands, rename them, and
set their colour and army bonus from this dialogue box. You can select
the current Island (the one new nodes are added to) from the drop-down
menu in the toolbar of the main window. Note that the names you give
your continents must match the names printed in the background sprite,
otherwise the user won't know which continents provide which bonus
levels when playing the game.


Creating a level from scratch
-----------------------------

To make a completely new level, first create the backdrop sprite in
Paint or some other sprite editor. Then run IslEdit and click on the
iconbar icon. A 'Create Level' dialogue box will open. Set the desired
title, author information and dimensions, and drag your sprite file to
the dropbox. Then click on the Create button. IslEdit will create the
level using the sprite backdrop supplied. Once you've done adding and
editing nodes, save the level in the usual way.

You can alter the basic level information once you've started by going
to 'File>Level info' in the main menu, and update the backdrop sprite by
going to 'Map>Backdrop'. You can't alter the dimensions of the level
once you've started.


Other options
-------------

Selecting File>Quit from the main menu quits the editing session and
closes the current file. Selecting Quit from the iconbar menu closes the
application. The current version details can be found from the Info
window on the iconbar menu.


Final words
-----------

Islands requires RISC OS 3.8 (or above) and around 500K free to run. 
The display looks best in 256 colours or more.

This application is Freeware, which means you may distribute it free of
charge. Please do not modify the code or alter any other part without
the permission of the author. 

Constructive criticism, ideas for improvements and general comments are
welcome.

This file for use with IslEdit version 1.00.

 Little Yellow Moon Software 2006.

email@lym.iconbar.com
www.lym.iconbar.com

